Package | hl7.fhir.uv.sdc |
Type | CapabilityStatement |
Id | Id |
FHIR Version | R4 |
Source | http://hl7.org/fhir/uv/sdc/https://build.fhir.org/ig/HL7/sdc/CapabilityStatement-sdc-form-response-manager.html |
Url | http://hl7.org/fhir/uv/sdc/CapabilityStatement/sdc-form-response-manager |
Version | 4.0.0-ballot |
Status | active |
Date | 2014-07-06 |
Name | SDCFormResponseManager |
Title | SDC Form Response Manager |
Experimental | False |
Realm | uv |
Authority | hl7 |
Description | This profile defines the expected capabilities of the ''SDC Form Response Manager'' role when conforming to the S&I Framework's [[index.html|Structured Data Capture FHIR implementation guide]]. This role is responsible for providing read/write access to QuestionnaireResponses. This is typically to support light-weight clients that want to be able to complete forms but do not have local storage to save work in progress. |
Kind | requirements |
CapabilityStatement | |
https://smartforms.csiro.au/ig/CapabilityStatement/SFLauncherServerAboriginalTorresStraitIslanderHealthCheck | Smart Forms Launcher Server for the Aboriginal and Torres Strait Islander Health Check |
CapabilityStatement | |
sdc-form-manager | SDC Form Manager |
sdc-form-manager | SDC Form Manager |
http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse | SDC Standard Questionnaire Response |
http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse | SDC Questionnaire Response |
Note: links and images are rebased to the (stated) source
Generated Narrative: CapabilityStatement sdc-form-response-manager
xml
, json
Note to Implementers: FHIR Capabilities
Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.
This CapabilityStatement instantiates the CapabilityStatement SDC Form Manager
server
Implementations must meet the general security requirements documented in the [[security.html|SDC implementation guide]]. Systems may wish to ensure that QuestionnaireResponse instances are only accessible to the user (or at least the organization) who was responsible for creating them.
The summary table lists the resources that are part of this configuration, and for each resource it lists:
_include
_revinclude
Resource Type | Profile | R | S | U | C | D | H-I | Searches | _include | _revinclude | Operations |
---|---|---|---|---|---|---|---|---|---|---|---|
QuestionnaireResponse | http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse | y | y | y | y | y | y |
create
This creates an initial version of a QuestionnaireResponse - a completed form for a particular subject as of a particular point-in-time
update
This allows revision of a QuestionnaireResponse. Typically this will happen while the response is still 'in-progress'. If it occurs after the response has been marked as 'final', the status should change to 'amended'. Updates can also be used to change the status to 'entered-in-error' or other values. Servers may choose to enforce business rules around what state transitions are supported and for which users.
search-type
This allows a user to find previously created responses - whether created by themselves or others. For thin clients without persistence, this feature is essential to allow them to find a draft of a previously created response
read
This allows a user to retrieve a previously stored response by id. (Some thin clients may have limited persistence -e.g. cookies - that could be used to store an id and later retrieve a work-in-progress questionnaire response
delete
This removes a previously submitted QuestionnaireResponse. In addition to (or instead of) supporting direct requests for deletion, some servers may automatically purge QuestionnaireResponses that have been in existence and unmodified for a period of time. Deletions may not be a physical delete and it may still be possible to access older versions of a deleted response
history-instance
This allows a user to look at previous versions of a response. It supports identifying what changes were made and potentially retrieving an older version to use as a starting point in the event that data has accidentally been removed or changed
This allows QuestionnaireResponses to be created, updated and retrieved. Note that storing a QuestionnaireResponse does not imply any execution of behavior on the basis of the stored data.
{
"resourceType" : "CapabilityStatement",
"id" : "sdc-form-response-manager",
"text" : {
"status" : "extensions",
"div" : "<div xmlns=\"http://www.w3.org/1999/xhtml\"><p class=\"res-header-id\"><b>Generated Narrative: CapabilityStatement sdc-form-response-manager</b></p><a name=\"sdc-form-response-manager\"> </a><a name=\"hcsdc-form-response-manager\"> </a><a name=\"sdc-form-response-manager-en-US\"> </a><h2 id=\"title\">SDC Form Response Manager</h2><ul><li>Implementation Guide Version: 4.0.0-ballot </li><li>FHIR Version: 1.0.0 </li><li>Supported Formats: <code>xml</code>, <code>json</code></li><li>Supported Patch Formats: </li><li>Published on: 2014-07-06 </li><li>Published by: HL7 International / FHIR Infrastructure </li></ul><blockquote class=\"impl-note\"><p><strong>Note to Implementers: FHIR Capabilities</strong></p><p>Any FHIR capability may be 'allowed' by the system unless explicitly marked as 'SHALL NOT'. A few items are marked as MAY in the Implementation Guide to highlight their potential relevance to the use case.</p></blockquote><p>This CapabilityStatement instantiates the CapabilityStatement <a href=\"CapabilityStatement-sdc-form-manager.html\">SDC Form Manager</a></p><h2 id=\"rest\">FHIR RESTful Capabilities</h2><div class=\"panel panel-default\"><div class=\"panel-heading\"><h3 id=\"mode1\" class=\"panel-title\">Mode: <code>server</code></h3></div><div class=\"panel-body\"><div class=\"lead\"><em>Security</em></div><blockquote><div><p>Implementations must meet the general security requirements documented in the [[security.html|SDC implementation guide]]. Systems may wish to ensure that QuestionnaireResponse instances are only accessible to the user (or at least the organization) who was responsible for creating them.</p>\n</div></blockquote><div class=\"lead\"><em>Summary of System-wide Interactions</em></div></div></div><h3 id=\"resourcesCap1\">Capabilities by Resource/Profile</h3><h4 id=\"resourcesSummary1\">Summary</h4><p>The summary table lists the resources that are part of this configuration, and for each resource it lists:</p><ul><li>The relevant profiles (if any)</li><li>The interactions supported by each resource (<b><span class=\"bg-info\">R</span></b>ead, <b><span class=\"bg-info\">S</span></b>earch, <b><span class=\"bg-info\">U</span></b>pdate, and <b><span class=\"bg-info\">C</span></b>reate, are always shown, while <b><span class=\"bg-info\">VR</span></b>ead, <b><span class=\"bg-info\">P</span></b>atch, <b><span class=\"bg-info\">D</span></b>elete, <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">I</span></b>nstance, or <b><span class=\"bg-info\">H</span></b>istory on <b><span class=\"bg-info\">T</span></b>ype are only present if at least one of the resources has support for them.</li><li><span>The required, recommended, and some optional search parameters (if any). </span></li><li>The linked resources enabled for <code>_include</code></li><li>The other resources enabled for <code>_revinclude</code></li><li>The operations on the resource (if any)</li></ul><div class=\"table-responsive\"><table class=\"table table-condensed table-hover\"><thead><tr><th><b>Resource Type</b></th><th><b>Profile</b></th><th class=\"text-center\"><b title=\"GET a resource (read interaction)\">R</b></th><th class=\"text-center\"><b title=\"GET all set of resources of the type (search interaction)\">S</b></th><th class=\"text-center\"><b title=\"PUT a new resource version (update interaction)\">U</b></th><th class=\"text-center\"><b title=\"POST a new resource (create interaction)\">C</b></th><th class=\"text-center\"><b title=\"DELETE a resource (delete interaction)\">D</b></th><th class=\"text-center\"><b title=\"GET changes to a resource (history interaction on instance)\">H-I</b></th><th><b title=\"Required and recommended search parameters\">Searches</b></th><th><code><b>_include</b></code></th><th><code><b>_revinclude</b></code></th><th><b>Operations</b></th></tr></thead><tbody><tr><td><a href=\"#QuestionnaireResponse1-1\">QuestionnaireResponse</a></td><td><a href=\"StructureDefinition-sdc-questionnaireresponse.html\">http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse</a></td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td class=\"text-center\">y</td><td></td><td/><td/><td/></tr></tbody></table></div><hr/><div class=\"panel panel-default\"><div class=\"panel-heading\"><h4 id=\"QuestionnaireResponse1-1\" class=\"panel-title\"><span style=\"float: right;\">Resource Conformance: SHALL </span>QuestionnaireResponse</h4></div><div class=\"panel-body\"><div class=\"container\"><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Base System Profile</span><br/><a href=\"StructureDefinition-sdc-questionnaireresponse.html\">SDC Standard Questionnaire Response</a></div><div class=\"col-lg-3\"><span class=\"lead\">Profile Conformance</span><br/><b>SHALL</b></div><div class=\"col-lg-3\"><span class=\"lead\">Reference Policy</span><br/></div></div><p/><div class=\"row\"><div class=\"col-lg-6\"><span class=\"lead\">Interaction summary</span><br/><ul><li><strong>SHALL</strong> support <br/><code>create</code><div><p>This creates an initial version of a QuestionnaireResponse - a completed form for a particular subject as of a particular point-in-time</p>\n</div><code>update</code><div><p>This allows revision of a QuestionnaireResponse. Typically this will happen while the response is still 'in-progress'. If it occurs after the response has been marked as 'final', the status should change to 'amended'. Updates can also be used to change the status to 'entered-in-error' or other values. Servers may choose to enforce business rules around what state transitions are supported and for which users.</p>\n</div><code>search-type</code><div><p>This allows a user to find previously created responses - whether created by themselves or others. For thin clients without persistence, this feature is essential to allow them to find a draft of a previously created response</p>\n</div><code>read</code><div><p>This allows a user to retrieve a previously stored response by id. (Some thin clients may have limited persistence -e.g. cookies - that could be used to store an id and later retrieve a work-in-progress questionnaire response</p>\n</div></li><li><strong>SHOULD</strong> support <br/><code>delete</code><div><p>This removes a previously submitted QuestionnaireResponse. In addition to (or instead of) supporting direct requests for deletion, some servers may automatically purge QuestionnaireResponses that have been in existence and unmodified for a period of time. Deletions may not be a physical delete and it may still be possible to access older versions of a deleted response</p>\n</div></li><li><strong>MAY</strong> support <br/><code>history-instance</code><div><p>This allows a user to look at previous versions of a response. It supports identifying what changes were made and potentially retrieving an older version to use as a starting point in the event that data has accidentally been removed or changed</p>\n</div></li></ul></div></div><p/><div class=\"row\"><div class=\"col-12\"><span class=\"lead\">Documentation</span><blockquote><div><p>This allows QuestionnaireResponses to be created, updated and retrieved. Note that storing a QuestionnaireResponse does not imply any execution of behavior on the basis of the stored data.</p>\n</div></blockquote></div></div></div></div></div></div>"
},
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-wg",
"valueCode" : "fhir"
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-fmm",
"valueInteger" : 4,
"_valueInteger" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical" : "http://hl7.org/fhir/uv/sdc/ImplementationGuide/hl7.fhir.uv.sdc"
}
]
}
},
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-standards-status",
"valueCode" : "trial-use",
"_valueCode" : {
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/structuredefinition-conformance-derivedFrom",
"valueCanonical" : "http://hl7.org/fhir/uv/sdc/ImplementationGuide/hl7.fhir.uv.sdc"
}
]
}
}
],
"url" : "http://hl7.org/fhir/uv/sdc/CapabilityStatement/sdc-form-response-manager",
"version" : "4.0.0-ballot",
"name" : "SDCFormResponseManager",
"title" : "SDC Form Response Manager",
"status" : "active",
"date" : "2014-07-06",
"publisher" : "HL7 International / FHIR Infrastructure",
"contact" : [
{
"name" : "HL7 International / FHIR Infrastructure",
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/fiwg"
}
]
},
{
"telecom" : [
{
"system" : "url",
"value" : "http://www.hl7.org/Special/committees/fiwg"
}
]
}
],
"description" : "This profile defines the expected capabilities of the ''SDC Form Response Manager'' role when conforming to the S&I Framework's [[index.html|Structured Data Capture FHIR implementation guide]]. This role is responsible for providing read/write access to QuestionnaireResponses. This is typically to support light-weight clients that want to be able to complete forms but do not have local storage to save work in progress.",
"jurisdiction" : [
{
"coding" : [
{
"system" : "http://unstats.un.org/unsd/methods/m49/m49.htm",
"code" : "001",
"display" : "World"
}
]
}
],
"kind" : "requirements",
"instantiates" : [
"http://hl7.org/fhir/uv/sdc/CapabilityStatement/sdc-form-manager"
],
"fhirVersion" : "1.0.0",
"format" : [
"xml",
"json"
],
"rest" : [
{
"mode" : "server",
"security" : {
"description" : "Implementations must meet the general security requirements documented in the [[security.html|SDC implementation guide]]. Systems may wish to ensure that QuestionnaireResponse instances are only accessible to the user (or at least the organization) who was responsible for creating them."
},
"resource" : [
{
"type" : "QuestionnaireResponse",
"profile" : "http://hl7.org/fhir/uv/sdc/StructureDefinition/sdc-questionnaireresponse",
"documentation" : "This allows QuestionnaireResponses to be created, updated and retrieved. Note that storing a QuestionnaireResponse does not imply any execution of behavior on the basis of the stored data.",
"interaction" : [
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "create",
"documentation" : "This creates an initial version of a QuestionnaireResponse - a completed form for a particular subject as of a particular point-in-time"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "update",
"documentation" : "This allows revision of a QuestionnaireResponse. Typically this will happen while the response is still 'in-progress'. If it occurs after the response has been marked as 'final', the status should change to 'amended'. Updates can also be used to change the status to 'entered-in-error' or other values. Servers may choose to enforce business rules around what state transitions are supported and for which users."
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHOULD"
}
],
"code" : "delete",
"documentation" : "This removes a previously submitted QuestionnaireResponse. In addition to (or instead of) supporting direct requests for deletion, some servers may automatically purge QuestionnaireResponses that have been in existence and unmodified for a period of time. Deletions may not be a physical delete and it may still be possible to access older versions of a deleted response"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "search-type",
"documentation" : "This allows a user to find previously created responses - whether created by themselves or others. For thin clients without persistence, this feature is essential to allow them to find a draft of a previously created response"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "SHALL"
}
],
"code" : "read",
"documentation" : "This allows a user to retrieve a previously stored response by id. (Some thin clients may have limited persistence -e.g. cookies - that could be used to store an id and later retrieve a work-in-progress questionnaire response"
},
{
"extension" : [
{
"url" : "http://hl7.org/fhir/StructureDefinition/capabilitystatement-expectation",
"valueCode" : "MAY"
}
],
"code" : "history-instance",
"documentation" : "This allows a user to look at previous versions of a response. It supports identifying what changes were made and potentially retrieving an older version to use as a starting point in the event that data has accidentally been removed or changed"
}
]
}
]
}
]
}
XIG built as of ??metadata-date??. Found ??metadata-resources?? resources in ??metadata-packages?? packages.